nlcst-to-string

What is nlcst-to-string?

The `nlcst-to-string` package is a utility for converting NLCST (Natural Language Concrete Syntax Tree) nodes to plain text strings. It is commonly used in natural language processing tasks where you need to extract text from a syntax tree structure.

What are nlcst-to-string's main functionalities?

Convert NLCST node to string

This feature allows you to convert an NLCST node into a plain text string. The code sample demonstrates how to use the `nlcst-to-string` package to convert a simple NLCST node containing the words 'Hello' and 'world' into a plain text string.

const toString = require('nlcst-to-string');
const nlcstNode = {
  type: 'WordNode',
  children: [
    { type: 'TextNode', value: 'Hello' },
    { type: 'TextNode', value: ' ' },
    { type: 'TextNode', value: 'world' }
  ]
};
const text = toString(nlcstNode);
console.log(text); // Output: 'Hello world'

Other packages similar to nlcst-to-string

unist-util-visit

The `unist-util-visit` package is used for traversing and manipulating Unist syntax trees, which are a more general form of syntax trees that NLCST is based on. While `unist-util-visit` focuses on tree traversal and manipulation, `nlcst-to-string` specifically focuses on converting NLCST nodes to strings.

hast-util-to-string

The `hast-util-to-string` package is similar to `nlcst-to-string` but is used for converting HAST (Hypertext Abstract Syntax Tree) nodes to strings. HAST is used for representing HTML, whereas NLCST is used for natural language. Both packages serve similar purposes but for different types of syntax trees.

mdast-util-to-string

The `mdast-util-to-string` package is used for converting MDAST (Markdown Abstract Syntax Tree) nodes to strings. Like `nlcst-to-string`, it focuses on converting nodes to plain text but is specific to Markdown syntax trees. This makes it useful for tasks involving Markdown processing.

README

nlcst-to-string

Transform an NLCST node into a string.

Installation

npm:

npm install nlcst-to-string

nlcst-to-string is also available for bower, component, and duo, and as an AMD, CommonJS, and globals module, uncompressed and compressed.

Usage

var nlcstToString = require('nlcst-to-string');

console.log(nlcstToString({
    "type": "WordNode",
    "data": {
        "partOfSpeech": [
            "NNP",
            "NN"
        ]
    },
    "children": [
        {
            "type": "TextNode",
            "value": "AT"
        },
        {
            "type": "PunctuationNode",
            "value": "&"
        },
        {
            "type": "TextNode",
            "value": "T"
        }
    ]
}));

Yields:

AT&T

API

toString(node[, separator])

Stringify an NLCST node (or an array of NLCST nodes).

Signatures

• toString(node[, separator]);
• toString(nodes[, separator]).

Parameters

• node (NLCSTNode) — Node to to stringify.

• nodes (Array.<NLCSTNode>) — Nodes to to stringify.

• separator (string, optional, default: '') — Value to separate each item with.

Returns

string — Stringified node / nodes.

License

MIT © Titus Wormer